mollie-api-typescript 1.3.4 → 1.3.6

package/src/models/listsettlementrefundresponse.ts

@@ -0,0 +1,580 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b39df3ccac20
+ */
+
+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 {
+  Metadata,
+  Metadata$inboundSchema,
+  Metadata$Outbound,
+  Metadata$outboundSchema,
+} from "./metadata.js";
+import {
+  RefundExternalReferenceTypeResponse,
+  RefundExternalReferenceTypeResponse$inboundSchema,
+  RefundExternalReferenceTypeResponse$outboundSchema,
+} from "./refundexternalreferencetyperesponse.js";
+import {
+  SettlementMode,
+  SettlementMode$inboundSchema,
+  SettlementMode$outboundSchema,
+} from "./settlementmode.js";
+import {
+  SettlementRefundStatus,
+  SettlementRefundStatus$inboundSchema,
+  SettlementRefundStatus$outboundSchema,
+} from "./settlementrefundstatus.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 ListSettlementRefundResponseSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+export type ListSettlementRefundResponseExternalReference = {
+  /**
+   * 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 ListSettlementRefundResponseSource = {
+  organizationId?: string | undefined;
+};
+
+export type ListSettlementRefundResponseRoutingReversal = {
+  /**
+   * 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?: ListSettlementRefundResponseSource | undefined;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListSettlementRefundResponseLinks = {
+  /**
+   * 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 ListSettlementRefundResponse = {
+  /**
+   * 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. Settlements are always in live mode.
+   */
+  mode: SettlementMode;
+  /**
+   * 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?:
+    | ListSettlementRefundResponseSettlementAmount
+    | 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;
+  /**
+   * The refund's status. Settlement refunds always have a status of `refunded`.
+   */
+  status: SettlementRefundStatus;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  externalReference?: ListSettlementRefundResponseExternalReference | 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<ListSettlementRefundResponseRoutingReversal>
+    | null
+    | undefined;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListSettlementRefundResponseLinks;
+};
+
+/** @internal */
+export const ListSettlementRefundResponseSettlementAmount$inboundSchema:
+  z.ZodType<
+    ListSettlementRefundResponseSettlementAmount,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    currency: z.string(),
+    value: z.string(),
+  });
+/** @internal */
+export type ListSettlementRefundResponseSettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListSettlementRefundResponseSettlementAmount$outboundSchema:
+  z.ZodType<
+    ListSettlementRefundResponseSettlementAmount$Outbound,
+    z.ZodTypeDef,
+    ListSettlementRefundResponseSettlementAmount
+  > = z.object({
+    currency: z.string(),
+    value: z.string(),
+  });
+
+export function listSettlementRefundResponseSettlementAmountToJSON(
+  listSettlementRefundResponseSettlementAmount:
+    ListSettlementRefundResponseSettlementAmount,
+): string {
+  return JSON.stringify(
+    ListSettlementRefundResponseSettlementAmount$outboundSchema.parse(
+      listSettlementRefundResponseSettlementAmount,
+    ),
+  );
+}
+export function listSettlementRefundResponseSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListSettlementRefundResponseSettlementAmount,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementRefundResponseSettlementAmount$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListSettlementRefundResponseSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementRefundResponseExternalReference$inboundSchema:
+  z.ZodType<
+    ListSettlementRefundResponseExternalReference,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    type: RefundExternalReferenceTypeResponse$inboundSchema.optional(),
+    id: z.string().optional(),
+  });
+/** @internal */
+export type ListSettlementRefundResponseExternalReference$Outbound = {
+  type?: string | undefined;
+  id?: string | undefined;
+};
+
+/** @internal */
+export const ListSettlementRefundResponseExternalReference$outboundSchema:
+  z.ZodType<
+    ListSettlementRefundResponseExternalReference$Outbound,
+    z.ZodTypeDef,
+    ListSettlementRefundResponseExternalReference
+  > = z.object({
+    type: RefundExternalReferenceTypeResponse$outboundSchema.optional(),
+    id: z.string().optional(),
+  });
+
+export function listSettlementRefundResponseExternalReferenceToJSON(
+  listSettlementRefundResponseExternalReference:
+    ListSettlementRefundResponseExternalReference,
+): string {
+  return JSON.stringify(
+    ListSettlementRefundResponseExternalReference$outboundSchema.parse(
+      listSettlementRefundResponseExternalReference,
+    ),
+  );
+}
+export function listSettlementRefundResponseExternalReferenceFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListSettlementRefundResponseExternalReference,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementRefundResponseExternalReference$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListSettlementRefundResponseExternalReference' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementRefundResponseSource$inboundSchema: z.ZodType<
+  ListSettlementRefundResponseSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  organizationId: z.string().optional(),
+});
+/** @internal */
+export type ListSettlementRefundResponseSource$Outbound = {
+  organizationId?: string | undefined;
+};
+
+/** @internal */
+export const ListSettlementRefundResponseSource$outboundSchema: z.ZodType<
+  ListSettlementRefundResponseSource$Outbound,
+  z.ZodTypeDef,
+  ListSettlementRefundResponseSource
+> = z.object({
+  organizationId: z.string().optional(),
+});
+
+export function listSettlementRefundResponseSourceToJSON(
+  listSettlementRefundResponseSource: ListSettlementRefundResponseSource,
+): string {
+  return JSON.stringify(
+    ListSettlementRefundResponseSource$outboundSchema.parse(
+      listSettlementRefundResponseSource,
+    ),
+  );
+}
+export function listSettlementRefundResponseSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSettlementRefundResponseSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementRefundResponseSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSettlementRefundResponseSource' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementRefundResponseRoutingReversal$inboundSchema:
+  z.ZodType<
+    ListSettlementRefundResponseRoutingReversal,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    amount: Amount$inboundSchema.optional(),
+    source: z.lazy(() => ListSettlementRefundResponseSource$inboundSchema)
+      .optional(),
+  });
+/** @internal */
+export type ListSettlementRefundResponseRoutingReversal$Outbound = {
+  amount?: Amount$Outbound | undefined;
+  source?: ListSettlementRefundResponseSource$Outbound | undefined;
+};
+
+/** @internal */
+export const ListSettlementRefundResponseRoutingReversal$outboundSchema:
+  z.ZodType<
+    ListSettlementRefundResponseRoutingReversal$Outbound,
+    z.ZodTypeDef,
+    ListSettlementRefundResponseRoutingReversal
+  > = z.object({
+    amount: Amount$outboundSchema.optional(),
+    source: z.lazy(() => ListSettlementRefundResponseSource$outboundSchema)
+      .optional(),
+  });
+
+export function listSettlementRefundResponseRoutingReversalToJSON(
+  listSettlementRefundResponseRoutingReversal:
+    ListSettlementRefundResponseRoutingReversal,
+): string {
+  return JSON.stringify(
+    ListSettlementRefundResponseRoutingReversal$outboundSchema.parse(
+      listSettlementRefundResponseRoutingReversal,
+    ),
+  );
+}
+export function listSettlementRefundResponseRoutingReversalFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListSettlementRefundResponseRoutingReversal,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementRefundResponseRoutingReversal$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListSettlementRefundResponseRoutingReversal' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementRefundResponseLinks$inboundSchema: z.ZodType<
+  ListSettlementRefundResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  payment: Url$inboundSchema,
+  settlement: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+/** @internal */
+export type ListSettlementRefundResponseLinks$Outbound = {
+  self: Url$Outbound;
+  payment: Url$Outbound;
+  settlement?: UrlNullable$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ListSettlementRefundResponseLinks$outboundSchema: z.ZodType<
+  ListSettlementRefundResponseLinks$Outbound,
+  z.ZodTypeDef,
+  ListSettlementRefundResponseLinks
+> = z.object({
+  self: Url$outboundSchema,
+  payment: Url$outboundSchema,
+  settlement: z.nullable(UrlNullable$outboundSchema).optional(),
+});
+
+export function listSettlementRefundResponseLinksToJSON(
+  listSettlementRefundResponseLinks: ListSettlementRefundResponseLinks,
+): string {
+  return JSON.stringify(
+    ListSettlementRefundResponseLinks$outboundSchema.parse(
+      listSettlementRefundResponseLinks,
+    ),
+  );
+}
+export function listSettlementRefundResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSettlementRefundResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSettlementRefundResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSettlementRefundResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementRefundResponse$inboundSchema: z.ZodType<
+  ListSettlementRefundResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: SettlementMode$inboundSchema,
+  description: z.string(),
+  amount: Amount$inboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => ListSettlementRefundResponseSettlementAmount$inboundSchema),
+  ).optional(),
+  metadata: z.nullable(Metadata$inboundSchema),
+  paymentId: z.string().optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  status: SettlementRefundStatus$inboundSchema,
+  createdAt: z.string(),
+  externalReference: z.lazy(() =>
+    ListSettlementRefundResponseExternalReference$inboundSchema
+  ).optional(),
+  routingReversals: z.nullable(
+    z.array(z.lazy(() =>
+      ListSettlementRefundResponseRoutingReversal$inboundSchema
+    )),
+  ).optional(),
+  _links: z.lazy(() => ListSettlementRefundResponseLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListSettlementRefundResponse$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  description: string;
+  amount: Amount$Outbound;
+  settlementAmount?:
+    | ListSettlementRefundResponseSettlementAmount$Outbound
+    | null
+    | undefined;
+  metadata: Metadata$Outbound | null;
+  paymentId?: string | undefined;
+  settlementId?: string | null | undefined;
+  status: string;
+  createdAt: string;
+  externalReference?:
+    | ListSettlementRefundResponseExternalReference$Outbound
+    | undefined;
+  routingReversals?:
+    | Array<ListSettlementRefundResponseRoutingReversal$Outbound>
+    | null
+    | undefined;
+  _links: ListSettlementRefundResponseLinks$Outbound;
+};
+
+/** @internal */
+export const ListSettlementRefundResponse$outboundSchema: z.ZodType<
+  ListSettlementRefundResponse$Outbound,
+  z.ZodTypeDef,
+  ListSettlementRefundResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: SettlementMode$outboundSchema,
+  description: z.string(),
+  amount: Amount$outboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => ListSettlementRefundResponseSettlementAmount$outboundSchema),
+  ).optional(),
+  metadata: z.nullable(Metadata$outboundSchema),
+  paymentId: z.string().optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  status: SettlementRefundStatus$outboundSchema,
+  createdAt: z.string(),
+  externalReference: z.lazy(() =>
+    ListSettlementRefundResponseExternalReference$outboundSchema
+  ).optional(),
+  routingReversals: z.nullable(
+    z.array(z.lazy(() =>
+      ListSettlementRefundResponseRoutingReversal$outboundSchema
+    )),
+  ).optional(),
+  links: z.lazy(() => ListSettlementRefundResponseLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listSettlementRefundResponseToJSON(
+  listSettlementRefundResponse: ListSettlementRefundResponse,
+): string {
+  return JSON.stringify(
+    ListSettlementRefundResponse$outboundSchema.parse(
+      listSettlementRefundResponse,
+    ),
+  );
+}
+export function listSettlementRefundResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSettlementRefundResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSettlementRefundResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSettlementRefundResponse' from JSON`,
+  );
+}