mollie-api-typescript 0.8.6 → 0.9.0

package/src/models/listentityrefundresponse.ts

@@ -0,0 +1,585 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  Amount,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  Metadata,
+  Metadata$inboundSchema,
+  Metadata$Outbound,
+  Metadata$outboundSchema,
+} from "./metadata.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  RefundExternalReferenceTypeResponse,
+  RefundExternalReferenceTypeResponse$inboundSchema,
+  RefundExternalReferenceTypeResponse$outboundSchema,
+} from "./refundexternalreferencetyperesponse.js";
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+import {
+  UrlNullable,
+  UrlNullable$inboundSchema,
+  UrlNullable$Outbound,
+  UrlNullable$outboundSchema,
+} from "./urlnullable.js";
+
+/**
+ * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+ *
+ * @remarks
+ * to the currency your account is settled in.
+ *
+ * The amount is a **negative** amount.
+ *
+ * If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be
+ * zero.
+ *
+ * Since the field contains an estimated amount during refund processing, it may change over time. For example, while
+ * the refund is queued the settlement amount is likely not yet available.
+ *
+ * To retrieve accurate settlement amounts we recommend using the
+ * [List balance transactions endpoint](list-balance-transactions) instead.
+ */
+export type ListEntityRefundResponseSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+export const ListEntityRefundResponseStatus = {
+  Queued: "queued",
+  Pending: "pending",
+  Processing: "processing",
+  Refunded: "refunded",
+  Failed: "failed",
+  Canceled: "canceled",
+} as const;
+export type ListEntityRefundResponseStatus = OpenEnum<
+  typeof ListEntityRefundResponseStatus
+>;
+
+export type ListEntityRefundResponseExternalReference = {
+  /**
+   * Specifies the reference type
+   */
+  type?: RefundExternalReferenceTypeResponse | undefined;
+  /**
+   * Unique reference from the payment provider
+   */
+  id?: string | undefined;
+};
+
+/**
+ * Where the funds will be pulled back from.
+ */
+export type ListEntityRefundResponseSource = {
+  organizationId?: string | undefined;
+};
+
+export type ListEntityRefundResponseRoutingReversal = {
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount?: Amount | undefined;
+  /**
+   * Where the funds will be pulled back from.
+   */
+  source?: ListEntityRefundResponseSource | undefined;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListEntityRefundResponseLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  payment: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  settlement?: UrlNullable | null | undefined;
+};
+
+export type ListEntityRefundResponse = {
+  /**
+   * Indicates the response contains a refund object. Will always contain the string `refund` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this refund. Mollie assigns this identifier at refund creation time. Mollie
+   *
+   * @remarks
+   * will always refer to the refund by this ID. Example: `re_4qqhO89gsT`.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The description of the refund that may be shown to your customer, depending on the payment method used.
+   */
+  description: string;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+   *
+   * @remarks
+   * to the currency your account is settled in.
+   *
+   * The amount is a **negative** amount.
+   *
+   * If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be
+   * zero.
+   *
+   * Since the field contains an estimated amount during refund processing, it may change over time. For example, while
+   * the refund is queued the settlement amount is likely not yet available.
+   *
+   * To retrieve accurate settlement amounts we recommend using the
+   * [List balance transactions endpoint](list-balance-transactions) instead.
+   */
+  settlementAmount?:
+    | ListEntityRefundResponseSettlementAmount
+    | null
+    | undefined;
+  /**
+   * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+   *
+   * @remarks
+   * you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+   */
+  metadata: Metadata | null;
+  /**
+   * The unique identifier of the payment this refund was created for.
+   *
+   * @remarks
+   * The full payment object can be retrieved via the payment URL in the `_links` object.
+   */
+  paymentId?: string | undefined;
+  /**
+   * The identifier referring to the settlement this refund was settled with. This field is omitted if the refund is not settled (yet).
+   */
+  settlementId?: string | null | undefined;
+  status: ListEntityRefundResponseStatus;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  externalReference?: ListEntityRefundResponseExternalReference | undefined;
+  /**
+   * *This feature is only available to marketplace operators.*
+   *
+   * @remarks
+   *
+   * When creating refunds for *routed* payments, by default the full amount is deducted from your balance.
+   *
+   * If you want to pull back funds from the connected merchant(s), you can use this parameter to specify what amount
+   * needs to be reversed from which merchant(s).
+   *
+   * If you simply want to fully reverse the routed funds, you can also use the `reverseRouting` parameter instead.
+   */
+  routingReversals?:
+    | Array<ListEntityRefundResponseRoutingReversal>
+    | null
+    | undefined;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListEntityRefundResponseLinks;
+};
+
+/** @internal */
+export const ListEntityRefundResponseSettlementAmount$inboundSchema: z.ZodType<
+  ListEntityRefundResponseSettlementAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityRefundResponseSettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityRefundResponseSettlementAmount$outboundSchema: z.ZodType<
+  ListEntityRefundResponseSettlementAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundResponseSettlementAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityRefundResponseSettlementAmountToJSON(
+  listEntityRefundResponseSettlementAmount:
+    ListEntityRefundResponseSettlementAmount,
+): string {
+  return JSON.stringify(
+    ListEntityRefundResponseSettlementAmount$outboundSchema.parse(
+      listEntityRefundResponseSettlementAmount,
+    ),
+  );
+}
+export function listEntityRefundResponseSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListEntityRefundResponseSettlementAmount,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityRefundResponseSettlementAmount$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListEntityRefundResponseSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundResponseStatus$inboundSchema: z.ZodType<
+  ListEntityRefundResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListEntityRefundResponseStatus);
+/** @internal */
+export const ListEntityRefundResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListEntityRefundResponseStatus
+> = openEnums.outboundSchema(ListEntityRefundResponseStatus);
+
+/** @internal */
+export const ListEntityRefundResponseExternalReference$inboundSchema: z.ZodType<
+  ListEntityRefundResponseExternalReference,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: RefundExternalReferenceTypeResponse$inboundSchema.optional(),
+  id: z.string().optional(),
+});
+/** @internal */
+export type ListEntityRefundResponseExternalReference$Outbound = {
+  type?: string | undefined;
+  id?: string | undefined;
+};
+
+/** @internal */
+export const ListEntityRefundResponseExternalReference$outboundSchema:
+  z.ZodType<
+    ListEntityRefundResponseExternalReference$Outbound,
+    z.ZodTypeDef,
+    ListEntityRefundResponseExternalReference
+  > = z.object({
+    type: RefundExternalReferenceTypeResponse$outboundSchema.optional(),
+    id: z.string().optional(),
+  });
+
+export function listEntityRefundResponseExternalReferenceToJSON(
+  listEntityRefundResponseExternalReference:
+    ListEntityRefundResponseExternalReference,
+): string {
+  return JSON.stringify(
+    ListEntityRefundResponseExternalReference$outboundSchema.parse(
+      listEntityRefundResponseExternalReference,
+    ),
+  );
+}
+export function listEntityRefundResponseExternalReferenceFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListEntityRefundResponseExternalReference,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityRefundResponseExternalReference$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListEntityRefundResponseExternalReference' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundResponseSource$inboundSchema: z.ZodType<
+  ListEntityRefundResponseSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  organizationId: z.string().optional(),
+});
+/** @internal */
+export type ListEntityRefundResponseSource$Outbound = {
+  organizationId?: string | undefined;
+};
+
+/** @internal */
+export const ListEntityRefundResponseSource$outboundSchema: z.ZodType<
+  ListEntityRefundResponseSource$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundResponseSource
+> = z.object({
+  organizationId: z.string().optional(),
+});
+
+export function listEntityRefundResponseSourceToJSON(
+  listEntityRefundResponseSource: ListEntityRefundResponseSource,
+): string {
+  return JSON.stringify(
+    ListEntityRefundResponseSource$outboundSchema.parse(
+      listEntityRefundResponseSource,
+    ),
+  );
+}
+export function listEntityRefundResponseSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefundResponseSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefundResponseSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefundResponseSource' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundResponseRoutingReversal$inboundSchema: z.ZodType<
+  ListEntityRefundResponseRoutingReversal,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: Amount$inboundSchema.optional(),
+  source: z.lazy(() => ListEntityRefundResponseSource$inboundSchema).optional(),
+});
+/** @internal */
+export type ListEntityRefundResponseRoutingReversal$Outbound = {
+  amount?: Amount$Outbound | undefined;
+  source?: ListEntityRefundResponseSource$Outbound | undefined;
+};
+
+/** @internal */
+export const ListEntityRefundResponseRoutingReversal$outboundSchema: z.ZodType<
+  ListEntityRefundResponseRoutingReversal$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundResponseRoutingReversal
+> = z.object({
+  amount: Amount$outboundSchema.optional(),
+  source: z.lazy(() => ListEntityRefundResponseSource$outboundSchema)
+    .optional(),
+});
+
+export function listEntityRefundResponseRoutingReversalToJSON(
+  listEntityRefundResponseRoutingReversal:
+    ListEntityRefundResponseRoutingReversal,
+): string {
+  return JSON.stringify(
+    ListEntityRefundResponseRoutingReversal$outboundSchema.parse(
+      listEntityRefundResponseRoutingReversal,
+    ),
+  );
+}
+export function listEntityRefundResponseRoutingReversalFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListEntityRefundResponseRoutingReversal,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityRefundResponseRoutingReversal$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListEntityRefundResponseRoutingReversal' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundResponseLinks$inboundSchema: z.ZodType<
+  ListEntityRefundResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  payment: Url$inboundSchema,
+  settlement: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+/** @internal */
+export type ListEntityRefundResponseLinks$Outbound = {
+  self: Url$Outbound;
+  payment: Url$Outbound;
+  settlement?: UrlNullable$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ListEntityRefundResponseLinks$outboundSchema: z.ZodType<
+  ListEntityRefundResponseLinks$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundResponseLinks
+> = z.object({
+  self: Url$outboundSchema,
+  payment: Url$outboundSchema,
+  settlement: z.nullable(UrlNullable$outboundSchema).optional(),
+});
+
+export function listEntityRefundResponseLinksToJSON(
+  listEntityRefundResponseLinks: ListEntityRefundResponseLinks,
+): string {
+  return JSON.stringify(
+    ListEntityRefundResponseLinks$outboundSchema.parse(
+      listEntityRefundResponseLinks,
+    ),
+  );
+}
+export function listEntityRefundResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefundResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefundResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefundResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityRefundResponse$inboundSchema: z.ZodType<
+  ListEntityRefundResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  description: z.string(),
+  amount: Amount$inboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => ListEntityRefundResponseSettlementAmount$inboundSchema),
+  ).optional(),
+  metadata: z.nullable(Metadata$inboundSchema),
+  paymentId: z.string().optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  status: ListEntityRefundResponseStatus$inboundSchema,
+  createdAt: z.string(),
+  externalReference: z.lazy(() =>
+    ListEntityRefundResponseExternalReference$inboundSchema
+  ).optional(),
+  routingReversals: z.nullable(
+    z.array(
+      z.lazy(() => ListEntityRefundResponseRoutingReversal$inboundSchema),
+    ),
+  ).optional(),
+  _links: z.lazy(() => ListEntityRefundResponseLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListEntityRefundResponse$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  description: string;
+  amount: Amount$Outbound;
+  settlementAmount?:
+    | ListEntityRefundResponseSettlementAmount$Outbound
+    | null
+    | undefined;
+  metadata: Metadata$Outbound | null;
+  paymentId?: string | undefined;
+  settlementId?: string | null | undefined;
+  status: string;
+  createdAt: string;
+  externalReference?:
+    | ListEntityRefundResponseExternalReference$Outbound
+    | undefined;
+  routingReversals?:
+    | Array<ListEntityRefundResponseRoutingReversal$Outbound>
+    | null
+    | undefined;
+  _links: ListEntityRefundResponseLinks$Outbound;
+};
+
+/** @internal */
+export const ListEntityRefundResponse$outboundSchema: z.ZodType<
+  ListEntityRefundResponse$Outbound,
+  z.ZodTypeDef,
+  ListEntityRefundResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  description: z.string(),
+  amount: Amount$outboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => ListEntityRefundResponseSettlementAmount$outboundSchema),
+  ).optional(),
+  metadata: z.nullable(Metadata$outboundSchema),
+  paymentId: z.string().optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  status: ListEntityRefundResponseStatus$outboundSchema,
+  createdAt: z.string(),
+  externalReference: z.lazy(() =>
+    ListEntityRefundResponseExternalReference$outboundSchema
+  ).optional(),
+  routingReversals: z.nullable(
+    z.array(
+      z.lazy(() => ListEntityRefundResponseRoutingReversal$outboundSchema),
+    ),
+  ).optional(),
+  links: z.lazy(() => ListEntityRefundResponseLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listEntityRefundResponseToJSON(
+  listEntityRefundResponse: ListEntityRefundResponse,
+): string {
+  return JSON.stringify(
+    ListEntityRefundResponse$outboundSchema.parse(listEntityRefundResponse),
+  );
+}
+export function listEntityRefundResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityRefundResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityRefundResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityRefundResponse' from JSON`,
+  );
+}